| Package | hl7.fhir.us.davinci-pr |
| Type | OperationDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-pr/https://build.fhir.org/ig/HL7/davinci-pr/OperationDefinition-SearchByPayment.html |
| Url | http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment |
| Version | 1.0.0-ballot |
| Status | active |
| Date | 2024-12-16T14:03:45+00:00 |
| Name | SearchByPayment |
| Title | Search for Postable Remittance By Payment |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This operation is used to search for a postable remittance by providing payment information. |
| Type | false |
| Kind | operation |
| CapabilityStatement | |
PostableRemittanceClientCapabilities  | Postable Remittance Client Capabilities |
| PostableRemittanceServerCapabilities | Postable Remittance Server Capabilities |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition SearchByPayment
URL: [base]/$searchByPayment
Input parameters Profile:Search By Payment Incoming Parameters
Output parameters Profile:Search By Payment Result Outgoing Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | TIN | 1..1 | string | Medical Group / Billing Provider / Payee TIN | ||
| IN | DateOfService | 0..1 | Period | Date of Service | ||
| IN | PayerID | 0..1 | string | Payer Identifer | ||
| IN | PayerName | 0..1 | string | Payer Name | ||
| IN | PaymentInfo | 1..1 | Information about the payment being searched for. | |||
| IN | PaymentInfo.PaymentIssueDate | 1..1 | Period | Payment Issue Date | ||
| IN | PaymentInfo.PaymentAmountRange | 0..1 | Payment Amount Range | |||
| IN | PaymentInfo.PaymentAmountRange.PaymentAmountLow | 1..1 | Money | Payment Number Low | ||
| IN | PaymentInfo.PaymentAmountRange.PaymentAmountHigh | 1..1 | Money | Payment Number High | ||
| IN | PaymentInfo.PaymentNumber | 1..1 | string | Payment Number - EFT/Cheque/Unique Remit Number | ||
| OUT | TIN | 0..1 | string | Medical Group / Billing Provider / Payee TIN | ||
| OUT | Payer | 0..1 | Details of payer information. | |||
| OUT | Payer.PayerID | 1..1 | string | Payer Identifier | ||
| OUT | Payer.PayerName | 1..1 | string | Payer Name | ||
| OUT | PaymentInfo | 0..* | Details of adjudicated payment. | |||
| OUT | PaymentInfo.PaymentDate | 1..1 | date | Payment Date | ||
| OUT | PaymentInfo.PaymentNumber | 1..1 | string | Payment Number | ||
| OUT | PaymentInfo.PaymentAmount | 1..1 | Money | Payment Amount | ||
| OUT | PaymentInfo.Remittance | 0..* | Details of remittance advice. | |||
| OUT | PaymentInfo.Remittance.RemittanceAdviceIdentifier | 1..1 | string | Remittance Advice Identifier | ||
| OUT | PaymentInfo.Remittance.RemittanceAdviceType | 1..1 | code | Remittance Advice Value Set (Required) | Remittance Advice Type | |
| OUT | PaymentInfo.Remittance.RemittanceAdviceDate | 1..1 | date | Remittance Advice Date | ||
| OUT | PaymentInfo.Remittance.RemittanceAdviceFileSize | 1..1 | integer | Remittance Advice File Size |
FHIR{
"resourceType" : "OperationDefinition",
"id" : "SearchByPayment",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SearchByPayment</b></p><a name=\"SearchByPayment\"> </a><a name=\"hcSearchByPayment\"> </a><a name=\"SearchByPayment-en-US\"> </a><p>URL: [base]/$searchByPayment</p><p>Input parameters Profile:<a href=\"StructureDefinition-searchByPaymentParameters.html\">Search By Payment Incoming Parameters</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-searchByPaymentResultParameters.html\">Search By Payment Result Outgoing Parameters</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>TIN</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Medical Group / Billing Provider / Payee TIN</p>\n</div></td></tr><tr><td>IN</td><td>DateOfService</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td><div><p>Date of Service</p>\n</div></td></tr><tr><td>IN</td><td>PayerID</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payer Identifer</p>\n</div></td></tr><tr><td>IN</td><td>PayerName</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payer Name</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo</td><td/><td>1..1</td><td></td><td/><td><div><p>Information about the payment being searched for.</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentIssueDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td><div><p>Payment Issue Date</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange</td><td/><td>0..1</td><td></td><td/><td><div><p>Payment Amount Range</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange.PaymentAmountLow</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Money\">Money</a></td><td/><td><div><p>Payment Number Low</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange.PaymentAmountHigh</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Money\">Money</a></td><td/><td><div><p>Payment Number High</p>\n</div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentNumber</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payment Number - EFT/Cheque/Unique Remit Number</p>\n</div></td></tr><tr><td>OUT</td><td>TIN</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Medical Group / Billing Provider / Payee TIN</p>\n</div></td></tr><tr><td>OUT</td><td>Payer</td><td/><td>0..1</td><td></td><td/><td><div><p>Details of payer information.</p>\n</div></td></tr><tr><td>OUT</td><td>Payer.PayerID</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payer Identifier</p>\n</div></td></tr><tr><td>OUT</td><td>Payer.PayerName</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payer Name</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo</td><td/><td>0..*</td><td></td><td/><td><div><p>Details of adjudicated payment.</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Payment Date</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentNumber</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Payment Number</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentAmount</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Money\">Money</a></td><td/><td><div><p>Payment Amount</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance</td><td/><td>0..*</td><td></td><td/><td><div><p>Details of remittance advice.</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceIdentifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Remittance Advice Identifier</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceType</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-RemittanceAdviceType.html\">Remittance Advice Value Set</a> (Required)</td><td><div><p>Remittance Advice Type</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Remittance Advice Date</p>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceFileSize</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Remittance Advice File Size</p>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "claims"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment",
"version" : "1.0.0-ballot",
"name" : "SearchByPayment",
"title" : "Search for Postable Remittance By Payment",
"status" : "active",
"kind" : "operation",
"date" : "2024-12-16T14:03:45+00:00",
"publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
"contact" : [
{
"name" : "HL7 International / Payer/Provider Information Exchange Work Group",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/claims"
}
]
}
],
"description" : "This operation is used to search for a postable remittance by providing payment information.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"code" : "searchByPayment",
"system" : true,
"type" : false,
"instance" : false,
"inputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters",
"outputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters",
"parameter" : [
{
"name" : "TIN",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Medical Group / Billing Provider / Payee TIN",
"type" : "string"
},
{
"name" : "DateOfService",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Date of Service",
"type" : "Period"
},
{
"name" : "PayerID",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Payer Identifer",
"type" : "string"
},
{
"name" : "PayerName",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Payer Name",
"type" : "string"
},
{
"name" : "PaymentInfo",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Information about the payment being searched for.",
"part" : [
{
"name" : "PaymentIssueDate",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Payment Issue Date",
"type" : "Period"
},
{
"name" : "PaymentAmountRange",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Payment Amount Range",
"part" : [
{
"name" : "PaymentAmountLow",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Payment Number Low",
"type" : "Money"
},
{
"name" : "PaymentAmountHigh",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Payment Number High",
"type" : "Money"
}
]
},
{
"name" : "PaymentNumber",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Payment Number - EFT/Cheque/Unique Remit Number",
"type" : "string"
}
]
},
{
"name" : "TIN",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Medical Group / Billing Provider / Payee TIN",
"type" : "string"
},
{
"name" : "Payer",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Details of payer information.",
"part" : [
{
"name" : "PayerID",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Payer Identifier",
"type" : "string"
},
{
"name" : "PayerName",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Payer Name",
"type" : "string"
}
]
},
{
"name" : "PaymentInfo",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Details of adjudicated payment.",
"part" : [
{
"name" : "PaymentDate",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Payment Date",
"type" : "date"
},
{
"name" : "PaymentNumber",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Payment Number",
"type" : "string"
},
{
"name" : "PaymentAmount",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Payment Amount",
"type" : "Money"
},
{
"name" : "Remittance",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Details of remittance advice.",
"part" : [
{
"name" : "RemittanceAdviceIdentifier",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Remittance Advice Identifier",
"type" : "string"
},
{
"name" : "RemittanceAdviceType",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Remittance Advice Type",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"
}
},
{
"name" : "RemittanceAdviceDate",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Remittance Advice Date",
"type" : "date"
},
{
"name" : "RemittanceAdviceFileSize",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Remittance Advice File Size",
"type" : "integer"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.